/*
 * Copyright 2009 The Apache Software Foundation Licensed under the Apache
 * License, Version 2.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law
 * or agreed to in writing, software distributed under the License is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */

package org.apache.ibatis.ibator.generator.ibatis3.xmlmapper.elements;

import org.apache.ibatis.ibator.api.IntrospectedColumn;
import org.apache.ibatis.ibator.api.dom.xml.Attribute;
import org.apache.ibatis.ibator.api.dom.xml.TextElement;
import org.apache.ibatis.ibator.api.dom.xml.XmlElement;
import org.apache.ibatis.ibator.config.GeneratedKey;
import org.apache.ibatis.ibator.generator.AbstractGenerator;
import org.apache.ibatis.ibator.internal.util.StringUtility;

/**
 * @author Jeff Butler
 */
public abstract class AbstractXmlElementGenerator extends AbstractGenerator
{
	public abstract void addElements(XmlElement parentElement);

	public AbstractXmlElementGenerator()
	{
		super();
	}

	/**
	 * This method should return an XmlElement for the select key used to
	 * automatically generate keys.
	 * 
	 * @param introspectedColumn
	 *            the column related to the select key statement
	 * @param generatedKey
	 *            the generated key for the current table
	 * @return the selectKey element
	 */
	protected XmlElement getSelectKey(IntrospectedColumn introspectedColumn,
			GeneratedKey generatedKey)
	{
		String identityColumnType = introspectedColumn
				.getFullyQualifiedJavaType().getFullyQualifiedName();

		XmlElement answer = new XmlElement("selectKey"); //$NON-NLS-1$
		answer.addAttribute(new Attribute("resultType", identityColumnType)); //$NON-NLS-1$
		answer.addAttribute(new Attribute(
				"keyProperty", introspectedColumn.getJavaProperty())); //$NON-NLS-1$
		if (StringUtility.stringHasValue(generatedKey.getType()))
		{
			if ("pre".equalsIgnoreCase(generatedKey.getType())) { //$NON-NLS-1$
				answer.addAttribute(new Attribute("order", "BEFORE")); //$NON-NLS-1$ //$NON-NLS-2$  
			}
			else
				if ("post".equalsIgnoreCase(generatedKey.getType())) { //$NON-NLS-1$
					answer.addAttribute(new Attribute("order", "AFTER")); //$NON-NLS-1$ //$NON-NLS-2$  
				}
				else
				{
					answer.addAttribute(new Attribute(
							"order", generatedKey.getType())); //$NON-NLS-1$  
				}
		}
		answer.addElement(new TextElement(generatedKey.getRuntimeSqlStatement()));

		return answer;
	}

	protected XmlElement getBaseColumnListElement()
	{
		XmlElement answer = new XmlElement("include"); //$NON-NLS-1$
		answer.addAttribute(new Attribute("refid", //$NON-NLS-1$
				introspectedTable.getBaseColumnListId())); //$NON-NLS-1$
		return answer;
	}

	protected XmlElement getBlobColumnListElement()
	{
		XmlElement answer = new XmlElement("include"); //$NON-NLS-1$
		answer.addAttribute(new Attribute("refid", //$NON-NLS-1$
				introspectedTable.getBlobColumnListId())); //$NON-NLS-1$
		return answer;
	}

	protected XmlElement getExampleIncludeElement()
	{
		XmlElement ifElement = new XmlElement("if"); //$NON-NLS-1$
		ifElement.addAttribute(new Attribute("test", "_parameter != null")); //$NON-NLS-1$ //$NON-NLS-2$

		XmlElement includeElement = new XmlElement("include"); //$NON-NLS-1$
		includeElement.addAttribute(new Attribute("refid", //$NON-NLS-1$
				introspectedTable.getExampleWhereClauseId())); //$NON-NLS-1$
		ifElement.addElement(includeElement);

		return ifElement;
	}

	protected XmlElement getUpdateByExampleIncludeElement()
	{
		XmlElement ifElement = new XmlElement("if"); //$NON-NLS-1$
		ifElement.addAttribute(new Attribute("test", "_parameter != null")); //$NON-NLS-1$ //$NON-NLS-2$

		XmlElement includeElement = new XmlElement("include"); //$NON-NLS-1$
		includeElement.addAttribute(new Attribute("refid", //$NON-NLS-1$
				introspectedTable.getIbatis3UpdateByExampleWhereClauseId())); //$NON-NLS-1$
		ifElement.addElement(includeElement);

		return ifElement;
	}
}
